Skip to content

Docs: lead Start Here with natural language or Python - #814

Merged
Jammy2211 merged 1 commit into
mainfrom
claude/compassionate-sagan-1yv43b
Nov 1, 2026
Merged

Jammy2211 merged 1 commit into
mainfrom
claude/compassionate-sagan-1yv43b

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Summary

Brings the PyAutoLens docs in line with PyAutoFit's natural-language-first docs, while keeping the pages about lensing first.

  • Start Here (docs/overview/overview_1_start_here.md, not renamed) still opens with strong lensing and the schematic. A new Natural Language or Python section follows:
    • a copyable start-here prompt for the autolens_assistant;
    • access notes (Claude Code / Codex recommended, free options via the AI Options page);
    • Why natural language? (syntax was never the science; the scientist supplies understanding, direction and judgement; links the PyAuto AI Policy);
    • Python is not going anywhere (the full Python API remains, all docs are written for people to read, HowToLens teaches the science so you can direct an analysis with expertise).
  • docs/index.md and README.md: the "Human-Readable Documentation" and "AI Assistant" sections become Natural Language or Python and Documentation and Examples.
  • New User Guide: the assistant boilerplate becomes one paragraph.
  • Prompt box: the copyable nl-prompt container is ported from PyAutoFit (docs/_static/pyautolens.css, copybutton_selector in conf.py). The shared pyauto.css is untouched.

Companion PRs: the start_here mode in autolens_assistant and autogalaxy_assistant, the same opening in both workspaces' start_here.py, and the matching PyAutoGalaxy docs PR.

Validation

  • The Sphinx build gives 130 warnings on both main and this branch, so no new warnings.
  • The rendered page was checked visually: the prompt box gets its copy button and the #natural-language-or-python anchor resolves.

Generated by Claude Code

Start Here opens with lensing, then a 'Natural Language or Python' section:
the start-here prompt for the autolens_assistant, access/free options, why
natural language (syntax is not the science) and that the Python API is not
going anywhere and all docs stay human readable (HowToLens teaches the
science). index.md and README Getting Started are restructured to match,
the New User Guide's assistant boilerplate becomes one paragraph, and the
copyable nl-prompt box is ported from PyAutoFit (pyautolens.css, copybutton
selector). No new Sphinx warnings (130 on main and branch).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016nhQ8QgLw3SZjRMSaX3v5z
@Jammy2211
Jammy2211 merged commit e91965f into main Nov 1, 2026
4 checks passed
@Jammy2211
Jammy2211 deleted the claude/compassionate-sagan-1yv43b branch November 1, 2026 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants